home *** CD-ROM | disk | FTP | other *** search
/ Aminet 37 / Aminet 37 (2000)(Schatztruhe)[!][Jun 2000].iso / Aminet / dev / asm / AmigaGS-Dev.lha / AmigaGS / Docs / FullDocEnglish.Asc
Text File  |  2000-04-13  |  7KB  |  316 lines
  1. ; *************************************************
  2. ; *                                               *
  3. ; *     AMIGA GAME STUDIO DEVELOPMENT PROJECT     *
  4. ; *                                               *
  5. ; *-----------------------------------------------*
  6. ; *                                               *
  7. ; *  List for all functions defined in libraries  *
  8. ; * given in AmigaGS archive :                    *
  9. ; *                                               *
  10. ; * Display???.Library         ECS/AGA  Ver : 1.0 *
  11. ; * Chunky???.Library          CPU020   Ver : 1.0 *
  12. ; * Ilbm.Library                        Ver : 1.0 *
  13. ; * Joystick.Library                    Ver : 1.0 *
  14. ; * MemoryBanks.Library                 Ver : 1.0 *
  15. ; * MemoryCopy???.Library      CPU020   Ver : 1.0 *
  16. ; * Screens???.Library         ECS/AGA  Ver : 1.0 *
  17. ; *                                               *
  18. ; *************************************************
  19. ; DATE : 13.April.2000 16:50
  20. ; Project Version 0.1a
  21. ;
  22. ;
  23. ; *******************
  24. ; *                 *
  25. ; * Display.Library *
  26. ; *                 *
  27. ; *******************
  28. ;
  29. 1 / Ags_Display :
  30. -----------------
  31.         In        :    /
  32.         Out        :    /
  33.         Help    :    Activate AmigaGS display instead of workbench
  34.                     
  35. 2 / WB_Display :
  36. ----------------
  37.         In        :    /
  38.         Out        :    /
  39.         Help    :    restore workbench display.
  40.  
  41. 3 / Ags_WaitVbl :
  42. -----------------
  43.         In        :    /
  44.         Out        :    /
  45.         Help    :    Wait for vertical refresh.
  46.  
  47. 4 / Ags_Screen :
  48. ----------------
  49.         In        :    A0=ScreenBase
  50.         Out        :    /
  51.         Help    :    Display any screen created with any of the
  52.                     "screens???.library"
  53.  
  54. 5 / Ags_SetColor :
  55. ------------------
  56.         In        :    D0=Color / D1=Red / D2=Green / D3=Blue
  57.         Out        :    /
  58.         Help    :    Define a 24bits color for AmigaGS display.
  59.  
  60. 6 / Ags_Copper:
  61. ---------------
  62.         In        :    /
  63.         Out        :    A0=AGS-CopperBase
  64.         Help    :    Give you the adress where the AmigaGS copper
  65.                     list is installed.
  66.  
  67. 7 / Refresh_Copper :
  68. --------------------
  69.         In        :    /
  70.         Out        :    /
  71.         Help    :    Send you back to AmigaGS Display.
  72.  
  73. 8 / Screen_Offset :
  74. -------------------
  75.         In        :    D0=XOffset / D1=YOffset
  76.         Out        :    /
  77.         Help    :    Make a scrolling for the screen installed in
  78.                     AmigaGS Display.
  79.  
  80. ;
  81. ; ******************
  82. ; *                *
  83. ; * Chunky.Library *
  84. ; *                *
  85. ; ******************
  86. ;
  87. 1 / Set_ChunkyBase :
  88. --------------------
  89.         In        :    A0=Chunky_ScreenBase
  90.         Out        :    /
  91.         Help    :    Define where your chunky screen is located in
  92.                     any kind of memory.
  93.  
  94. 2 / Set_ScreenBase :
  95. --------------------
  96.         In        :    A0=Planar_ScreenBase
  97.         Out        :    /
  98.         Help    :    Define where your planar screen is located in
  99.                     chip memory.
  100.                     ( all planes must be allocated contiguously)
  101.  
  102. 3 / Set_ChunkySize :
  103. --------------------
  104.         In        :    D0=XSize / D1=YSize
  105.         Out        :    /
  106.         Help    :    Define The sizes of your chunky screen.
  107.                     There are only 2 values available :
  108.                     D0=320 / D1=200 or D0=160 / D1=100
  109.  
  110. 4 / ChunkyConvert :
  111. -------------------
  112.         In        :    /
  113.         Out        :    /
  114.         Help    :    convert the graphics contained inside chunky
  115.                     screen to your planar screen.
  116.  
  117. 5 / ChunkyPlot :
  118. ----------------
  119.         In        :    D0=XPos(0-319) / D1=YPos(0-199) / D2=Ink(0-255)
  120.         Out        :    /
  121.         Help    :    Draw a point inside chunky screen.
  122.  
  123. ;
  124. ; ****************
  125. ; *              *
  126. ; * Ilbm.Library *
  127. ; *              *
  128. ; ****************
  129. ;
  130.  
  131. 1 / IlbmConvert :
  132. -----------------
  133.         In        :    A0=ScreenBase / A1=IffBase
  134.         Out        :    /
  135.         Help    :    Convert a previously loaded in memory IFF/ILBM
  136.                     file into an AmigaGS Screen.
  137.  
  138. 2 / IlbmXSize :
  139. ---------------
  140.         In        :    A0=IffBase
  141.         Out        :    D0=XSize
  142.         Help    :    Give you the X size of an IFF/ILBM Picture
  143.                     in memory.
  144.  
  145. 3 / IlbmYSize :
  146. ---------------
  147.         In        :    A0=IffBase
  148.         Out        :    D0=YSize
  149.         Help    :    Give you the Y size of an IFF/ILBM Picture
  150.                     in memory.
  151.  
  152. 4 / IlbmDepth :
  153. ---------------
  154.         In        :    A0=IffBase
  155.         Out        :    D0=Depth
  156.         Help    :    Give you how many bitplanes the IFF/ILBM picture
  157.                     loaded in memory use.
  158.  
  159. 5 / IlbmPalette :
  160. -----------------
  161.         In        :    A0=IffBase
  162.         Out        :    A1=CMAP Base
  163.         Help    :    Give you the Adress of the color palette inside
  164.                     The IFF/ILBM picture.
  165.  
  166. ;
  167. ; ********************
  168. ; *                  *
  169. ; * Joystick.Library *
  170. ; *                  *
  171. ; ********************
  172. ;
  173.                     
  174. 1 / Joy0State :
  175. ---------------
  176.         In        :    /
  177.         Out        :    D0=Joystick state
  178.         Help    :    Give you the state of any joystick connected to
  179.                     your mouse port (0).
  180.                     Bits in D0 are organized like this :
  181.                         Bit 0 = True -> Direction is UP
  182.                         Bit 1 = True -> Direction is DOWN
  183.                         Bit 2 = True -> Direction is LEFT
  184.                         Bit 3 = True -> Direction is RIGHT
  185.  
  186. 2 / Joy1State :
  187. ---------------
  188.         In        :    /
  189.         Out        :    D0=Joystick state
  190.         Help    :    Give you the state of any joystick connected to
  191.                     your joystick port (1).
  192.                     Bits in D0 are organized like this :
  193.                         Bit 0 = True -> Direction is UP
  194.                         Bit 1 = True -> Direction is DOWN
  195.                         Bit 2 = True -> Direction is LEFT
  196.                         Bit 3 = True -> Direction is RIGHT
  197.  
  198. 3 / Joy0Fire?State :
  199. --------------------
  200.         In        :    /
  201.         Out        :    D0=Button state
  202.         Help    :    Give you the state of any button of a joystick
  203.                     OR mouse connected to mouse port (0).
  204.                     You can check buttons 1,2 and 3.
  205.  
  206. 4 / Joy1Fire?State :
  207. --------------------
  208.         In        :    /
  209.         Out        :    D0=Button state
  210.         Help    :    Give you the state of any button of a joystick
  211.                     OR mouse connected to joystick port (1).
  212.                     You can check buttons 1,2 and 3.
  213.  
  214. 5 / ArrowsKeysState :
  215. ---------------------
  216.         In        :    /
  217.         Out        :    D0=Arrow key pressed .
  218.         Help    :    Tell you if any of 4 directions arrows keys has
  219.                     just been pushed.
  220.  
  221. ;
  222. ; ***********************
  223. ; *                     *
  224. ; * MemoryBanks.Library *
  225. ; *                     *
  226. ; ***********************
  227. ;
  228.  
  229. 1 / ReserveAsChipData :
  230. -----------------------
  231.         In        :    D0=Bank / D1=Size (in bytes)
  232.         Out        :    A0=BankBase
  233.         Help    :    Try to allocate memory from Chip-RAM
  234.  
  235. 2 / ReserveAsFastData :
  236. -----------------------
  237.         In        :    D0=Bank / D1=Size (in bytes)
  238.         Out        :    A0=BankBase
  239.         Help    :    Try to allocate memory from Fast-RAM
  240.  
  241. 3 / ReserveAsPublicData :
  242. -------------------------
  243.         In        :    D0=Bank / D1=Size (in bytes)
  244.         Out        :    A0=BankBase
  245.         Help    :    Try to allocate memory from Public-RAM type.
  246.  
  247. 4 / ReserveAs24BitDMAData :
  248. ---------------------------
  249.         In        :    D0=Bank / D1=Size (in bytes)
  250.         Out        :    A0=BankBase
  251.         Help    :    Try to allocate 24Bit DMA-Able memory.
  252.  
  253. 5 / BankBase :
  254. --------------
  255.         In        :    D0=Bank
  256.         Out        :    A0=BankBase
  257.         Help    :    Tell you where a bank is located in memory.
  258.  
  259. 6 / EraseBank :
  260. ---------------
  261.         In        :    D0=Bank
  262.         Out        :    /
  263.         Help    :    Erase a previously allocated memory bank.
  264.  
  265. 7 / EraseAllBanks :
  266. -------------------
  267.         In        :    /
  268.         Out        :    /
  269.         Help    :    Erase all previously allocated memory banks.
  270.  
  271. ;
  272. ; **********************
  273. ; *                    *
  274. ; * MemoryCOPY.Library *
  275. ; *                    *
  276. ; **********************
  277. ;
  278. 1 / MemoryClear :
  279. -----------------
  280.         In        :    A0=MemoryAdress / D0=Size (in bytes)
  281.         Out        :    /
  282.         Help    :    Clear a zone of memory.
  283.  
  284. 2 / MemoryCopy :
  285. ----------------
  286.         In        :    A0=Source / A1=Target / D0=Size (in bytes)
  287.         Out        :    /
  288.         Help    :    Copy D0 bytes from A0 memory zone to A1 memory
  289.                     zone.
  290.  
  291. ;
  292. ; *******************
  293. ; *                 *
  294. ; * Screens.Library *
  295. ; *                 *
  296. ; *******************
  297. ;
  298.  
  299. 1 / Screen_Open :
  300. -----------------
  301.         In        :    D0=Screen / D1=XSize / D2=YSize / D3=Depth
  302.         Out        :    /
  303.         Help    :    Open a screen using D3 bitplanes.
  304.  
  305. 2 / Screen_Close :
  306. ------------------
  307.         In        :    D0=Screen
  308.         Out        :    /
  309.         Help    :    Close a previously opened screen.
  310.  
  311. 3 / Screen_Base :
  312. -----------------
  313.         In        :    D0=Screen
  314.         Out        :    A0=ScreenBase
  315.         help    :    Give you where a screen is located.
  316.